home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr09 / graftr20.zip / GRAFTREE.DOC < prev    next >
Text File  |  1993-06-13  |  18KB  |  311 lines
  1.                 GRAFTREE Version 2
  2.                 December 7, 1990    
  3.                 Copyright Bill Beinert, 1990.
  4.                 
  5.                Compuserve 76407,132
  6.                 or
  7.                  PO Box 1974
  8.                  Peter Stuvesant Station
  9.                  New York, NY  10009
  10.  
  11.                      FILES INCLUDED
  12.      GRAFTREE.DOC   - This file.
  13.      GEDBROWS.EXE   - The GEDBROWS program
  14.      GRAFTREE.EXE   - The chart printing program
  15.      SAMPLE.GED     - A sample GEDCOM file
  16.      GT8PIN.FNT     - The font for 9 pin printers
  17.      GT24PIN.FNT    - The font for 24 pin (LQ) printers
  18.  
  19.      GRAFTREE consists of two programs that enable a genealogist to read
  20. GEDCOM files directly, as a group of related individuals, and to print
  21. Descendant Charts sideways on dot-matrix printers, banner style.
  22.      GRAFTREE is a shareware program. This means that you can try it out
  23. for free, let your friends try it out, or upload unmodified copies to
  24. bulletin boards. If you like it and use it, then you are required to
  25. register. The registration fee is a very reasonable $10, payable to me at
  26. the above address. It is certainly a small price to pay for the smiles on
  27. your relatives' faces. Other programs cost much more and require you to you
  28. key in your data again.
  29.      GEDBROWS is the first program. GEDCOM files, for those of you not
  30. already familiar with them, are a means of transmitting genealogical
  31. information from one computer system to another. The format, which has been
  32. standardized by the LDS church, is not suitable for use as a database, nor
  33. for easy viewing by humans, since it consists of a group of variable length
  34. records composed of a variable number of variable length fields, all
  35. internally cross-linked by identifying pointers. Closely related
  36. individuals may be widely separated in the file, and the records describing
  37. the families they are members of even more widely spaced. Viewing a GEDCOM
  38. with a text browser such as LIST or BROWSE is an exercise in frustration.
  39.      Previously, the only way a genealogist could determine who was in a
  40. GEDCOM was by importing the GEDCOM into his or her database, and using the
  41. database's facilities for viewing the individuals and their relationships.
  42. This often means maintaining separate databases, at least until it can be
  43. determined that the people in the GEDCOM should be merged into the main
  44. database.
  45.      GEDBROWS presents each individual on a separate screen, listing the
  46. person's name and dates, and the names of his or her parents. Below this is
  47. a list of each of the individual's spouses and children. Navigating through
  48. the GEDCOM is as simple as pointing to a person and pressing Enter.
  49.      GRAFTREE, the second program, produces a graphic family tree in a
  50. descendant format sideways on Epson LQ and IBM compatible printers.  Each
  51. descendant is enclosed in a box, with his or her birth and death dates, and
  52. first 2 spouses or dates for a sole spouse. Charts can be 42 generations
  53. deep and 100 pages wide. Charts deeper than 7 generations are supported by
  54. printing multiple banner style pages. For example, a 20 generation chart 5
  55. pages wide will be printed by printing the first 7 generations 5 pages
  56. wide, followed by generations 8 to 14 on the next 5 pages, then generations
  57. 15 to 20 on the next 5 pages. Separate the pages only after each 5 pages,
  58. and the three 5 page banners will line up.
  59.                               REQUIREMENTS
  60.  
  61.      Both programs require an MS or PC DOS compatible computer with 512K
  62. free RAM. All of GRAFTREE's files must be in the same directory. If you are
  63. using DOS 3.0 or later, you can put this directory in your PATH, and access
  64. it from anywhere. DOS 2.x requires that all of the files be in your current
  65. directory when you execute it (otherwise GRAFTREE won't be able to find the
  66. fonts).
  67.  
  68.      GEDCOM files must conform to Release 4.0 (August 1989) of the GEDCOM
  69. standard, as implemented by PAF 2.1 or later. Most popular genealogical
  70. database management systems, such as Roots III, The Family Edge, and
  71. Brother's Keeper, conform to this implementation. GEDCOM files prepared by
  72. or for use with PAF 2.0 are not supported.
  73.  
  74.      GRAFTREE supports IBM and compatible dot matrix printers. It should
  75. work on any printer that accepts IBM graphics commands, either 9 or 24
  76. pin.  If you have a 24 pin printer, try using the /LQ switch, which should
  77. work on any Epson LQ series 24 pin dot matrix printer or any printer that
  78. can emulate one.  The LQ version is very much faster than the IBM version. 
  79. Both produce Near Letter Quality output.
  80.   A note on pin spacing: 9 pin printers support a line feed of 1/216 inch.
  81. Epson LQ printers 1/180 inch.  This means that the IBM version will print
  82. OK on the Epson LQ but the logical page will be longer, resulting in boxes
  83. being printed over the perforations.
  84.  
  85.  
  86.                                 LIMITATIONS
  87.  
  88.  The GEDCOM Specification allows enormous flexibility in the contents
  89. of a GEDCOM file, more than GRAFTREE can handle, at least in it's early
  90. releases. If you encounter any of these limitations, please let me know.
  91. The following features permitted by the GEDCOM spec are NOT supported at
  92. this time:
  93.   1)   Multiple file GEDCOMs. GRAFTREE assumes that the input file contains
  94.      a complete GEDCOM.
  95.   2)   Number of people.  This version allows for 1000 descendants of the
  96.      common ancestor in 42 generations. The banner chart can be up to 100
  97.      pages wide. The GEDCOM cannot contain more than 2000 INDI records and
  98.      1000 FAM records.
  99.   3) Name lengths. A total of 27 characters will be printed.
  100.      Given names will be truncated if necessary.
  101.   4) Dates. Alternate calendars (@#D...@) are not supported.
  102.   5) Length designated values. @#Lnnn@ values are not supported.
  103.   6) Continued COMM tags are not supported.
  104.   7) The 8-Bit ANSEL character set is not supported. Non-ASCII
  105.      characters are ignored in names.
  106.  
  107.                           A SUGGESTION FOR PAPER
  108.  
  109.      Charts look better on good quality paper, and especially good on
  110. parchment paper. If it is not available at your local computer store (I
  111. have gotten it at Software, Etc.), you can order it by mail from
  112.  
  113.           Lyben Computer Systems    or       Paper Direct
  114.           1050 E. Maple Rd.                  57 Romanelli Ave
  115.           Troy, MI 48083                     South Hackensack, NJ 07606
  116.           (313) 589-3440                     (800) 272-7377
  117.                                 GEDBROWS
  118.                                INSTRUCTIONS
  119.  
  120.      Execute GEDBROWS by typing GEDBROWS and pressing Enter. You can
  121. provide the file specification of the GEDCOM file as a parameter. If you
  122. don't, GEDBROWS will prompt you for it. GEDBROWS will return an error
  123. message if it can't find the file, or it is not an acceptable GEDCOM. 
  124.      The first screen displays the Header, Submitter and Submission
  125. information found at the beginning of the file. If there is more data than
  126. can be shown on one screen, a second screen will be displayed, after you
  127. press any key.
  128.      The next screen will display the first person in the GEDCOM. It may
  129. take a while to display this screen, depending on the size and organization
  130. of the file. See the Notes on Performance.
  131.      The Display Individual screen shows the ID (the unique identifier in
  132. the GEDCOM) and name of the person, and the dates of birth and death. The
  133. IDs and names of the person's father and mother are also shown. Beneath the
  134. parents, the person's spouses and children are displayed. The Family ID is
  135. shown to the left of the spouse. The ID and name of each of these persons
  136. is separated by a cursor. Usually, the cursor looks like this: <--. If
  137. there are more than 17 spouses and children, however, the cursor will look
  138. like <++, indicating that fact. Use the Up and Down arrow keys to move the
  139. cursor to point to any spouse or child. If the cursor is <++, when you get
  140. to the bottom of the screen, the list of spouses and children will scroll
  141. up until you get to the bottom of the list. Scrolling up works the same
  142. way.
  143.      You can select the next person to display by pressing a single key:
  144.  
  145.      Enter     Display the person pointed to by the cursor
  146.      F or f    Display the father of the current person
  147.      M or m    Display the mother of the current person
  148.      Page Up   Display the previous person in the GEDCOM
  149.      Page Down Display the next person in the GEDCOM
  150.      Home      Display the first person in the GEDCOM
  151.      ?         Display a person by ID. GEDBROWS will prompt you for the     
  152.                ID of the person. Do not include the @s that surround the ID
  153.                in the GEDCOM. GEDBROWS handles those details.
  154.      Escape    Quit GEDBROWS
  155.  
  156.      Context sensitive help is available by pressing F1.
  157.  
  158.      GEDBROWS can be used to execute GRAFTREE. The F2 key will bring up a
  159. window that allows you to specify the parameters for GRAFTREE. Use the left
  160. and right arrow keys to set the number of generations to be charted. Use
  161. the Q key to toggle between 9 and 24 pin printers. The P key toggles the
  162. preview function, which displays the box on the screen before printing.
  163.      You can print the chart immediately from this screen by pressing F2
  164. again. Or you can press F3, and GEDBROWS will create or update a batch file
  165. named GTGEDBAT.BAT, which can be run at some time when it is convenient to
  166. let your printer run for a while. If GTGEDBAT.BAT already exists, you will
  167. be asked whether you want to replace it or add the new command to it. In
  168. this manner you can browse through a large GEDCOM, choose several persons
  169. to chart, then just run the batch file at your convenience. (The GEDCOM
  170. file must still be available when the batch file is run, of course.) The F1
  171. key provides help in this context also.
  172.                                 GRAFTREE
  173.                                INSTRUCTIONS
  174.  
  175. 1)     Use your genealogy database program to create a GEDCOM file. Methods 
  176.      of selecting the people to include in the GEDCOM vary with the
  177.      program. PAF will allow you to include all of the descendants of an
  178.      individual in a GEDCOM. Or you could include everyone in your
  179.      database, and create many different GRAFTREE charts from the same
  180.      GEDCOM. You may need to take care to limit the number of people and
  181.      families in the GEDCOM. See the previously listed limitations. Exit
  182.      your genealogy program. Make a note of the name of the GEDCOM file. It
  183.      will usually have an extension of GED.
  184.  
  185. 2)     You will also need to know the unique identifier of each of the
  186.      ancestors whose descendants  you wish to chart. (Not all of the people
  187.      on the chart, just the ancestors.) Every person in a GEDCOM must have
  188.      a unique identifier, which is created by the database program when it
  189.      creates the GEDCOM. PAF uses the RIN for this purpose. If your
  190.      program's documentation is unclear on what it assigns as identifiers
  191.      in a GEDCOM, use GEDBROWS to determine them.
  192.  
  193. 3)     Execute GRAFTREE by typing GRAFTREE, then press Enter.
  194.  
  195. 4)    GRAFTREE will prompt you for:
  196.      a)   The filespec of the .GED file created in step 1. You only need to
  197.           type as much of the filespec as you need to access the file from
  198.           your current directory. If it's in the current directory, just
  199.           the filename.ext will do.
  200.      b)   The Identifier of the common Ancestor whose descendants you wish
  201.           to chart. GRAFTREE will scan the GEDCOM to verify that the person
  202.           is there. The speed of your disk and size of the GEDCOM will
  203.           determine how long it takes.
  204.      c)   How many generations deep the chart should be. From 2 to 42. Use
  205.           the left and right arrow keys to change the number of desired
  206.           generations.
  207.      d)   What kind of printer you have. Use the letter Q key to toggle
  208.           between 9 and 24 pin printers. Laser printers are not supported.
  209.      e)   If you want a screen preview of what will be printed in the boxes
  210.           on the chart. The P key toggles Yes or no.
  211.  
  212.    GRAFTREE will then process the GEDCOM file and start printing. A count-
  213. down in pages will be displayed.  Note that is possible for some pages to
  214. be blank. These will take as long to print as if they had chart data. 
  215.  
  216.      You can stop printing by pressing any key.  GRAFTREE will ask you for  
  217. confirmation before aborting.
  218.  
  219. BATCH OPERATION
  220.  
  221. You can run GRAFTREE in a batch file. Large charts take a long time to
  222. print. You may want to create a batch file to do several charts overnight.
  223. (GEDBROWS can create such batch files automatically for you.)
  224.  The syntax is
  225.      GRAFTREE d:filespec ID n /LQ /P
  226.  
  227.    d:filespec  is the file specification of the GEDCOM file
  228.    ID          is the Identifier of the common Ancestor
  229.    n           is the number of generations to be charted
  230.    /LQ         (optional) for 24 pin printers. The default is 8 pin.
  231.    /P          (optional) to request a screen preview
  232.                          A NOTE ON PERFORMANCE
  233.  
  234.      The response time of GEDBROWS is highly dependent on several factors.
  235. The major ones are the size and organization of the GEDCOM file, and disk
  236. speed.
  237.      The GEDCOM spec says nothing about the order of individual and family
  238. records, so various database systems do it in different ways. PAF puts all
  239. of the individual records at the beginning, followed by all the families.
  240. In order to display the first person, GEDBROWS reads the first individual
  241. record, then has to scan past all the other individuals to get that
  242. person's family records (if there are any), then back to the individual
  243. records to get the names of the parents and children. Scanning back over
  244. individual records that have been previously read while looking for the
  245. family record takes very little time, since GEDBROWS builds indexes for all
  246. the individuals and families as they are read. With this type of file
  247. organization, you will wait a few moments before the first person is
  248. displayed. After that, though, response time will be consistently quick.
  249.      Other programs, such as ROOTS III, try to cluster individual and
  250. family records together. The first individual will be displayed more
  251. quickly, but subsequent response time will be a bit slower, since each step
  252. forward will require sequential reads, rather than indexed reads.
  253.  
  254.      The size of the GEDCOM file and the speed of the disk will naturally
  255. affect response time. While GEDBROWS pays little attention to many of the
  256. records and fields in the file (at least in this release), it still has to
  257. read through them to get to the data it needs. This takes time; disk access
  258. is the slowest thing on your system, and both GEDBROWS and GRAFTREE need to
  259. do a lot of it. A RAM disk or cache will help a lot.
  260.  
  261.      A chart of more than 7 generations can result in some totally blank
  262. pages within the chart. For example, if an individual has 7 children who,
  263. in turn, have no children, the columns below these 7 will remain blank for
  264. the depth of the chart. Also, if the family tree is wide at the bottom and
  265. narrow at the top (you may have only a single line for the first 7
  266. generations, then fill out as more information is available for more recent
  267. generations), the first and last pages of the first pass may be blank.
  268.      There are two things to note about these blank pages. One is that they
  269. are supposed to be there. The intent is that a deep chart will be printed
  270. as several banners of the same width, so you don't have to figure out where
  271. the breaks are. It also means fewer seams and a neater appearance when the
  272. banners are taped together for display. So don't be concerned if you
  273. request a deep chart, and the first several pages have nothing on them. 
  274.      The other is that these blank pages take as long to print as if they
  275. had data on them. This is understandably annoying, and a future release
  276. will recognize these situations and issue a page eject instead.
  277.  
  278.                            IN CASE OF PROBLEMS
  279.  
  280.        If your printer does strange things like move to the right margin    
  281. and just stay there, check your printer manual to see if it supports    
  282. double density graphics.  GRAFTREE uses the following graphic commands.    
  283. If your printer does not respond as expected to these commands,    
  284. GRAFTREE will not work.
  285.               ESC  @      resets printer to default settings.
  286.               ESC  2      sets line spacing to 1/6 in.
  287.               ESC  3 n    sets line spacing to n/180 or n/216.
  288.               ESC  L n m  sets printer to double density graphics mode
  289.                            with 256*m + n columns of data to follow.
  290.      
  291.      Besides the mailbox, I support GRAFTREE on Compuserve, in the
  292. Genealogy Forum (GO ROOTS). The Roots Forum is an ideal place for
  293. computerized genealogists to meet people with similar interests, give and
  294. get help and advice from others and just enjoy the company of your peers.
  295. Most major genealogy software vendors provide on-line support for their
  296. products in this forum. Join the party!
  297.  
  298.                         THOUGHTS FOR THE FUTURE
  299.  
  300.      Suggestions and comments are welcome. Address them to me at
  301.         Compuserve 76407,132, or write to
  302.                          Bill Beinert
  303.                          PO Box 1974
  304.                          Peter Stuyvesant Station
  305.                          New York, NY  10009
  306.                          
  307.       Suggestions for future development are welcome. Currently planned
  308. enhancements are optional shadowboxes, and an Ancestor chart. Performance
  309. improvements are also planned.
  310.  
  311.